org.eclipse.vtp.framework.interactions.core.commands
Class MetaDataMessageCommand

java.lang.Object
  org.eclipse.vtp.framework.interactions.core.commands.ConversationCommand
      org.eclipse.vtp.framework.interactions.core.commands.MetaDataMessageCommand

All Implemented Interfaces:

ICommand

public final class MetaDataMessageCommand
extends ConversationCommand

A command that sends meta-data to the user.

Author:

Lonnie Pryor

Field Summary

Fields inherited from class org.eclipse.vtp.framework.interactions.core.commands.ConversationCommand

INPUT_TYPE_CUSTOM, INPUT_TYPE_FILE, OUTPUT_TYPE_FILE, OUTPUT_TYPE_TEXT

Constructor Summary

MetaDataMessageCommand()
Creates a new MetaDataMessageCommand.

Method Summary

java.lang.Object	exportContents() Exports the contents of this command to a simple structure of arrays and serializable values from java.lang.
java.lang.String[]	getMetaDataNames() Returns the names of the meta-data in the interaction.
java.lang.String	getMetaDataValue(java.lang.String name) Returns the value of a meta-data item in the interaction.
java.lang.String[]	getParameterNames() Returns the names of the parameters that will be returned from the interaction.
java.lang.String[]	getParameterValues(java.lang.String name) Returns the values of a parameter to be set when the process resumes.
void	importContents(java.lang.Object contents) Configures the contents of this command with a structure previously returned from ICommand.exportContents().
void	setMetaDataValue(java.lang.String name, java.lang.String value) Configures a meta-data item in the interaction.
void	setParameterValues(java.lang.String name, java.lang.String[] values) Configures a parameter set when the current process resumes.

Methods inherited from class org.eclipse.vtp.framework.interactions.core.commands.ConversationCommand

accept

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MetaDataMessageCommand

public MetaDataMessageCommand()

Creates a new MetaDataMessageCommand.

Method Detail

getMetaDataNames

public java.lang.String[] getMetaDataNames()

Returns the names of the meta-data in the interaction.

Returns:

The names of the meta-data in the interaction.

getMetaDataValue

public java.lang.String getMetaDataValue(java.lang.String name)

Returns the value of a meta-data item in the interaction.

Parameters:

name - The name of the meta-data item to be set.

Returns:

The value that the specified meta-data item will be set to.

setMetaDataValue

public void setMetaDataValue(java.lang.String name,
                             java.lang.String value)

Configures a meta-data item in the interaction.

Parameters:

name - The name of the meta-data item to set.

value - The value to set the meta-data item to.

getParameterNames

public java.lang.String[] getParameterNames()

Returns the names of the parameters that will be returned from the interaction.

Returns:

The names of the parameters that will be returned from the interaction.

getParameterValues

public java.lang.String[] getParameterValues(java.lang.String name)

Returns the values of a parameter to be set when the process resumes.

Parameters:

name - The name of the parameter to be set.

Returns:

The values that specified parameter will be set to.

setParameterValues

public void setParameterValues(java.lang.String name,
                               java.lang.String[] values)

Configures a parameter set when the current process resumes.

Parameters:

name - The name of the parameter to set.

values - The values to set the parameter to.

exportContents

public java.lang.Object exportContents()

Description copied from interface: ICommand

Exports the contents of this command to a simple structure of arrays and serializable values from java.lang.

Returns:

A serializable structure this command can be re-constituted from.

importContents

public void importContents(java.lang.Object contents)

Description copied from interface: ICommand

Configures the contents of this command with a structure previously returned from ICommand.exportContents().

Parameters:

contents - The exported contents structure to load from.